<html>
<head>
<title>Docs For Class HTML_Progress_Generator</title>
<link rel="stylesheet" type="text/css" href="../../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: HTML_Progress_Generator</h1>
Source Location: /Progress/generator.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre>HTML_QuickForm_Controller
   |
   --HTML_Progress_Generator</pre><br />
<div class="description"></div><br /><br />







</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodHTML_Progress_Generator">HTML_Progress_Generator</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateButtons">createButtons</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateProgressBar">createProgressBar</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateTabs">createTabs</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methoddisableButton">disableButton</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodenableButton">enableButton</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 42]<br />
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodHTML_Progress_Generator"></a>
	<h3>constructor HTML_Progress_Generator <span class="smalllinenumber">[line 110]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>HTML_Progress_Generator HTML_Progress_Generator(
[mixed
$controllerName = 'ProgressGenerator'], [array
$attributes = array()], [array
$errorPrefs = array()], string
$controllerName(optional))</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Constructor Summary<br /><br /><p><ul><li>Creates a standard progress bar generator wizard.
   <div class="listing"><pre><ol><li>   <span class="src-var">$generator </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodHTML_Progress_Generator">HTML_Progress_Generator</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a progress bar generator wizard with
   customized actions: progress bar preview, form rendering, buttons manager
   <div class="listing"><pre><ol><li>   <span class="src-var">$controllerName </span>= <span class="src-str">'myPrivateGenerator'</span><span class="src-sym">;</span></li>
<li>   <span class="src-var">$attributes </span>= <span class="src-key">array</span><span class="src-sym">(</span></li>
<li>        <span class="src-str">'preview' </span>=&gt; <span class="src-id">name of a HTML_QuickForm_Action instance</span></li>
<li>                     <span class="src-sym">(</span><span class="src-key">default </span><span class="src-str">'ActionPreview'</span><span class="src-sym">, </span><span class="src-id">see </span><span class="src-str">'HTML/Progress/generator/preview.php'</span><span class="src-sym">)</span></li>
<li>        <span class="src-str">'display' </span>=&gt; <span class="src-id">name of a HTML_QuickForm_Action_Display instance</span></li>
<li>                     <span class="src-sym">(</span><span class="src-key">default </span><span class="src-str">'ActionDisplay'</span><span class="src-sym">, </span><span class="src-id">see </span><span class="src-str">'HTML/Progress/generator/default.php'</span><span class="src-sym">)</span></li>
<li>        <span class="src-str">'process' </span>=&gt; <span class="src-id">name of a HTML_QuickForm_Action instance</span></li>
<li>                     <span class="src-sym">(</span><span class="src-key">default </span><span class="src-str">'ActionProcess'</span><span class="src-sym">, </span><span class="src-id">see </span><span class="src-str">'HTML/Progress/generator/process.php'</span><span class="src-sym">)</span></li>
<li>   <span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>   <span class="src-var">$generator </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodHTML_Progress_Generator">HTML_Progress_Generator</a><span class="src-sym">(</span><span class="src-var">$controllerName</span><span class="src-sym">, </span><span class="src-var">$attributes</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$controllerName(optional)</b>&nbsp;&nbsp;</td>
        <td>Name of generator wizard (QuickForm)</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>(optional) List of renderer options</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$errorPrefs</b>&nbsp;&nbsp;</td>
        <td>(optional) Hash of params to configure error handler</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcreateButtons"></a>
	<h3>method createButtons <span class="smalllinenumber">[line 270]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void createButtons(
object
&$page, array
$buttons, [mixed
$attributes = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Adds all necessary buttons to the given page object.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$page</b>&nbsp;&nbsp;</td>
        <td>Page where to put the button</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$buttons</b>&nbsp;&nbsp;</td>
        <td>Key/label of each button/event to handle</td>
      </tr>
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>(optional) Either a typical HTML attribute string                                       or an associative array.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcreateProgressBar"></a>
	<h3>method createProgressBar <span class="smalllinenumber">[line 413]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void createProgressBar(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Creates a progress bar with options choosen on all wizard tabs.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcreateTabs"></a>
	<h3>method createTabs <span class="smalllinenumber">[line 228]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void createTabs(
object
&$page, [mixed
$attributes = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Adds all necessary tabs to the given page object.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$page</b>&nbsp;&nbsp;</td>
        <td>Page where to put the button</td>
      </tr>
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>(optional) Either a typical HTML attribute string                                       or an associative array.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddisableButton"></a>
	<h3>method disableButton <span class="smalllinenumber">[line 374]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void disableButton(
object
&$page, [array
$events = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Disables certain buttons for a page.<br /><br /><p>Buttons [ = events] : back, next, cancel, reset, apply, help</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodenableButton">HTML_Progress_Generator::enableButton()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$page</b>&nbsp;&nbsp;</td>
        <td>Page where you want to activate buttons</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$events</b>&nbsp;&nbsp;</td>
        <td>(optional) List of buttons</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodenableButton"></a>
	<h3>method enableButton <span class="smalllinenumber">[line 328]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void enableButton(
object
&$page, [array
$events = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Enables certain buttons for a page.<br /><br /><p>Buttons [ = events] : back, next, cancel, reset, apply, help</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methoddisableButton">HTML_Progress_Generator::disableButton()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$page</b>&nbsp;&nbsp;</td>
        <td>Page where you want to activate buttons</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$events</b>&nbsp;&nbsp;</td>
        <td>(optional) List of buttons</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:41 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>